Class: MinerApi
MinerApi - object-oriented interface
Export
Hierarchy
↳
MinerApi
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new MinerApi(configuration?, basePath?, fetch?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | undefined |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Properties
basePath
• Protected basePath: string = BASE_PATH
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
configuration
• Protected configuration: Configuration
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:58
fetch
• Protected fetch: FetchAPI = portableFetch
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Methods
publicMinersDealsMinerGet
▸ publicMinersDealsMinerGet(miner, ignoreFailed?, options?): Promise<Response>
This endpoint returns all miners deals
Summary
Get all miners deals
Throws
Memberof
MinerApi
Parameters
| Name | Type | Description |
|---|---|---|
miner | string | Filter by miner |
ignoreFailed? | string | Ignore Failed |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:4856
publicMinersStatsMinerGet
▸ publicMinersStatsMinerGet(miner, options?): Promise<Response>
This endpoint returns miner stats
Summary
Get miner stats
Throws
Memberof
MinerApi
Parameters
| Name | Type | Description |
|---|---|---|
miner | string | Filter by miner |
options? | any | Override http request option. |
Returns
Promise<Response>